Base class for all 3D nodes. More...

#include <kanzi/core.ui/node/node3d.hpp>

Inheritance diagram for kanzi::Node3D:

Classes
class	RenderEntryParameters
	Render entry parameters. More...

Public Types
typedef ChildContainer::const_iterator	ChildConstIterator

typedef ChildContainer::const_reverse_iterator	ChildConstReverseIterator

typedef vector< Node3DSharedPtr >	ChildContainer
	Iterators for child nodes. More...

typedef Matrix4x4	LayoutMatrixType

typedef Vector3	LayoutVectorType

using	RenderEntryParameterContainer = vector< RenderEntryParameters >
	The type to use to return render entries from nodes. More...

enum	RenderMode { RenderModeNone, RenderModeDefault, RenderModeCustom }
	Specifies the rendering modes available for a 3D node. More...

Public Types inherited from kanzi::Node
enum	ContentStretch { ContentStretchNone, ContentStretchFill, ContentStretchUniform, ContentStretchUniformToFill, ContentStretchRepeat }
	Content stretch option. More...

enum	DepthAlignment { DepthAlignmentBack, DepthAlignmentFront, DepthAlignmentCenter, DepthAlignmentStretch }
	Depth alignment options. More...

enum	HorizontalAlignment { HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter, HorizontalAlignmentStretch }
	Horizontal alignment options. More...

typedef InputManipulatorContainer::const_iterator	InputManipulatorConstIterator

typedef vector< InputManipulatorBaseSharedPtr >	InputManipulatorContainer
	Gets the input manipulator iterator. More...

typedef InputManipulatorContainer::iterator	InputManipulatorIterator

typedef kanzi::vector< Node::MessageSubscriptionToken >	MessageSubscriptionTokenVector

typedef NodeComponentContainer::const_iterator	NodeComponentConstIterator

typedef vector< NodeComponentEntry >	NodeComponentContainer
	Gets the node component iterator. More...

typedef NodeComponentContainer::iterator	NodeComponentIterator

enum	VerticalAlignment { VerticalAlignmentBottom, VerticalAlignmentTop, VerticalAlignmentCenter, VerticalAlignmentStretch }
	Vertical alignment options. More...

typedef function< VisitorResult(Node &)>	Visitor
	Defines the type of the function that Kanzi executes for each node when visiting a node tree. More...

enum	VisitorOrder { VisitorPreOrder, VisitorPostOrder }
	Defines the order in which Kanzi visits the nodes in a node tree. More...

enum	VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }
	Defines the return type of the Node::Visitor function. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Types inherited from kanzi::BindingHostConcept
using	BindingHostConceptSharedPtr = shared_ptr< BindingHostConcept >
	Binding host concept shared pointer type. More...

using	BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator
	Const iterator for binding runtimes. More...

using	BindingRuntimeContainer = vector< AbstractBindingRuntimeSharedPtr >
	Container for binding runtimes. More...

using	BindingRuntimeIterator = BindingRuntimeContainer::iterator
	Iterator for binding runtimes. More...

Public Member Functions
bool	addAbstractChildOverride (NodeSharedPtr child) override

void	addChild (const Node3DSharedPtr &child)
	Adds a child node to a 3D node. More...

void	arrange ()
	Performs layout arrangement on a 3D node. More...

void	arrangeIterate ()
	Initial scene arrange. More...

void	arrangeIterateLayout (bool propagateArrange)

void	arrangeIterateLayoutChild (bool propagateArrange)

ChildConstIterator	beginChildren () const

void	centeredArrange (Vector3 actualSize) const
	Default implementation of arrange for a layout that accommodates all children at its center. More...

Vector3	centeredMeasure (Vector3 availableSize) const
	Default implementation of measure for a layout that accommodates all children at its center. More...

ChildConstIterator	endChildren () const

const RenderEntryParameterContainer *	generateRenderStates (DrawObjectsRenderPass &drawPass)
	Gets a listing of render entry parameters to use to generate render states. More...

size_t	getAbstractChildCountOverride () override

size_t	getAbstractChildIndexOverride (const Node &node) override

NodeSharedPtr	getAbstractChildOverride (size_t index) override

Vector3	getActualSize () const
	Returns the actual size of a 3D node. More...

Vector3	getAllocatedOffset () const
	Returns the allocated offset of a 3D node. More...

Vector3	getAllocatedSize () const
	Returns the allocated size of a 3D node. More...

Matrix4x4	getArrangeTransformation () const
	Returns the layout transformation of a 3D node. More...

virtual optional< Box >	getBoundingBox () const
	Gets the bounding box of a 3D node. More...

Node3DSharedPtr	getChild (size_t index) const
	Gets a child node at a given `index`. More...

size_t	getChildCount () const
	Gets the number of child nodes in a 3D node. More...

size_t	getChildIndex (const Node &child) const
	Gets the index of a `child` node. More...

Vector3	getCoreDesiredSize () const
	Returns the core desired size of a 3D node. More...

Vector3	getDesiredSize () const
	Returns the desired size of a 3D node. More...

Node3DSharedPtr	getFaceToCameraTarget () const

void	getLayoutBoundingBoxSize (Vector3 &bboxMin, Vector3 &bboxMax) const
	Returns the size of the bounding box of a 3D node. More...

Node3DSharedPtr	getLookAtTarget () const

Vector3	getMaximumBoundingBoxCoordinates () const
	Returns the maximum coordinates for the bounding volume of a 3D node. More...

Vector3	getMinimumBoundingBoxCoordinates () const
	Returns the minimum coordinates for the bounding volume of a 3D node. More...

Node3DSharedPtr	getOrientationConstraintTarget () const

Vector3	getPivotOffset () const
	Returns the pivot offset of a 3D node. More...

Node3DSharedPtr	getPositionConstraintTarget () const

RenderMode	getRenderMode () const
	Returns the render mode. More...

Vector3	getSize () const
	Returns the size of a 3D node. More...

Vector3	getStretchScale () const
	Returns the stretch scale of a 3D node. More...

bool	hasChild (const Node &child) const
	Returns whether a child node exists. More...

virtual pair< NodeSharedPtr, float >	hitTestContent (const Ray &ray)
	Default hit test implementation of Node3D content. More...

void	insertChild (size_t index, const Node3DSharedPtr &child)
	Adds to a 3D node a `child` node at a given `index`. More...

bool	isPrimitiveLayout () const
	Indicates whether a 3D node has primitive layout behavior. More...

void	layout ()
	Calculates the layouts in a scene recursively. Calls the measure and arrange functions of every 3D node in the scene. More...

void	measure (const Vector3 &availableSize)
	Performs the default measure step. More...

void	measureIterate ()
	Initial scene measure. More...

virtual bool	measureRecursive ()
	Performs layout measurement for a 3D node. More...

bool	moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index) override
	Node::moveAbstractChildToPosition() implementation. More...

void	moveChildToPosition (Node3DSharedPtr child, size_t index)
	Moves a child node to a given position in the list of child nodes. More...

void	moveToBack ()
	Repositions a 3D node to the beginning of the list of child nodes of its parent node, so that Kanzi draws the node first. More...

void	moveToFront ()
	Repositions a 3D node to the end of the list of child nodes of its parent node, so that Kanzi draws the node last. More...

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Method executed on node property change. More...

virtual void	onTransform ()
	Per-node step performed on transform, after Kanzi calculates the final transformation. More...

ChildConstReverseIterator	rbeginChildren () const

void	registerDrawPass (DrawObjectsRenderPassSharedPtr drawPass)
	Registers a DrawObjectsRenderPass that renders a 3D node. More...

bool	removeAbstractChildOverride (Node &child) override

void	removeAllChildren ()
	Removes all child nodes from a 3D node. More...

void	removeChild (const Node &child)
	Removes a `child` node from a 3D node. More...

void	removeChild (size_t index)
	Removes from a 3D node a child node at a given `index`. More...

ChildConstReverseIterator	rendChildren () const

void	render (Renderer3D &renderer, RenderEntry3D &renderEntry)
	Renders a 3D node using a given render state. More...

void	setActualSize (const Vector3 &actualSize)
	Sets the actual size of a 3D node. More...

void	setAllocatedOffset (const Vector3 &allocatedOffset)
	Sets the allocated offset of a 3D node. More...

void	setAllocatedSize (const Vector3 &layoutSize)
	Sets the allocated size of a 3D node. More...

void	setArrangeTransformation (const Matrix4x4 &value)
	Sets the layout transformation of a 3D node. More...

void	setAutoDepth ()
	Sets a node to determine its depth automatically. More...

void	setAutoHeight ()
	Sets a node to determine its height automatically. More...

void	setAutoSize ()
	Sets a node to determine its width, height, and depth automatically. More...

void	setAutoWidth ()
	Sets a node to determine its width automatically. More...

void	setCoreDesiredSize (const Vector3 &coreDesiredSize)
	Sets the core desired size of a 3D node. More...

void	setDesiredSize (const Vector3 &desiredSize)
	Sets the desired size of a 3D node. More...

void	setLayoutBoundingBoxSize (const Vector3 &bboxMin, const Vector3 &bboxMax)
	Sets the size of the bounding box of a 3D node. More...

void	setPivotOffset (const Vector3 &pivotOffset)
	Sets the pivot offset of a 3D node. More...

void	setRenderMode (RenderMode mode)
	Sets the render mode. More...

void	setSize (float width, float height, float depth)
	Sets the dimensions of a node. More...

void	setSize (Vector3 size)
	Sets the dimensions of a node. More...

void	setStretchScale (const Vector3 &stretchScale)
	Sets the stretch scale of a 3D node. More...

	~Node3D () override

Public Member Functions inherited from kanzi::Node
ResourceSharedPtr	acquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...

template<typename T >
shared_ptr< T >	acquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. More...

ResourceManager::AcquireTaskSharedPtr	acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
	Posts an asynchronous task to acquire a resource. More...

ResourceDictionarySharedPtr	acquireResourceDictionary ()
	Gets a resource dictionary of a node. More...

void	addAnonymousResource (ResourceSharedPtr resource)
	Adds alias resource to an object node. More...

void	addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator)
	Transfers the ownership and attaches an input manipulator to an object node. More...

template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message filter where the filter is a method that is invoked on an object. More...

template<typename TMessageType >
MessageSubscriptionToken	addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message filter where the filter is a function. More...

template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message handler where the handler is a method that is invoked on an object. More...

template<typename TMessageType >
MessageSubscriptionToken	addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message handler where the handler is a function. More...

template<typename TMessageType >
MessageSubscriptionToken	addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
	Adds a message handler where the handler is a function and you explicitly define the accepted source. More...

void	addNodeComponent (NodeComponentSharedPtr nodeComponent)
	Transfers the ownership of a node component to an object node. More...

void	addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
	Transfers the ownership of a node component to an object node and sets the owner of the node component. More...

void	addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)

void	addResource (const ResourceID &resourceId, string_view resourceUrl)
	Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. More...

void	addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
	Adds a nested resource dictionary to the resource dictionary of a node. More...

void	addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
	This is a helper for automatic resource tracking in ResourceReference. More...

template<typename TMessageType >
MessageSubscriptionToken	addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message filter where the filter is a function. More...

template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message filter where the filter is a method that is invoked on an object. More...

template<typename TMessageType >
MessageSubscriptionToken	addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
	Adds a message handler where the handler is a function and you explicitly define the accepted source. More...

AppliedStyleEntrySharedPtr	applyManualStyle (StyleSharedPtr style)
	Applies a style to an object node. More...

AppliedStyleEntrySharedPtr	applyStyle (StyleSharedPtr style)
	Applies a style to an object node. More...

void	applyStyles ()
	Apply all styles for an object node. More...

void	applyStylesRecursive ()
	Applies styles recursively. More...

void	attachRecursive ()
	Attaches an object node and its children recursively. More...

InputManipulatorConstIterator	beginInputManipulators () const

NodeComponentConstIterator	beginNodeComponents () const

void	clearChangeFlag (uint32_t flag)
	Clears a change flag. More...

void	clearChildChangeFlag (uint32_t flag)
	Clears a child change flag. More...

bool	containsResource (const ResourceID &resourceID) const
	Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. More...

BindingLookupContextPtr	createLookupContext (NodeSharedPtr templateRoot)
	Creates a lookup context for the node. More...

void	detachRecursive ()
	Detaches a node and its descendants. More...

void	dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
	Dispatches a message from this node with specified arguments. More...

template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Dispatches a message from this node with specified arguments. More...

InputManipulatorConstIterator	endInputManipulators () const

NodeComponentConstIterator	endNodeComponents () const

template<typename TNodeType >
shared_ptr< TNodeType >	findAbstractChild (string_view name)
	Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. More...

optional< string >	findResourceURL (const ResourceID &resourceId) const
	Tries to find Resource URL for Resource ID from this node. More...

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

uint32_t	getChangeFlags () const
	Get current change flags. More...

uint32_t	getChildChangeFlags () const
	Get current child change flags. More...

FocusManager *	getFocusManager () const
	Returns the Focus Manager associated with the Screen node to which this node belongs. More...

FocusScope *	getFocusScopeInfo () const
	Returns the information about the focus scope for a node. More...

InputManager *	getInputManager () const
	Returns the Input Manager associated with the Screen node to which this node belongs. More...

AbstractPropertyTypeDescriptor::ValueSource *	getNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

template<typename DataType >
optional< typename PropertyType< DataType >::DataType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

Node *	getParent () const
	Returns the parent of the node. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

ResourceDictionarySharedPtr	getResourceDictionary () const
	If a node has a resource dictionary, returns the resource dictionary of that node. More...

Screen *	getScreen () const
	Returns the Screen node to which this node belongs. More...

NodeSharedPtr	getTemplateRoot () const
	Gets the template root of this node. More...

void	invalidateArrange ()
	Invalidates arrange. More...

void	invalidateDraw ()
	Invalidates draw flag for the node. More...

void	invalidateFinalTransform ()
	Invalidates final transform for node. More...

void	invalidateMeasure ()
	Invalidates measure for the node. More...

void	invalidateRender ()
	Invalidates render for node. More...

bool	isAnyChangeFlagSet (uint32_t flag) const
	Checks if any of given flags is set. More...

bool	isAnyChildChangeFlagSet (uint32_t flag) const
	Checks if any child change flags (corresponding to given mask) are set. More...

bool	isAttached () const
	Returns true if the node is attached to a screen or one of its descendants. More...

bool	isAttaching () const
	Returns true if node is in the process of attaching, false otherwise. More...

bool	isChangeFlagSet (uint32_t flag) const
	Checks if a change flag is set. More...

bool	isChildChangeFlagSet (uint32_t flag) const
	Checks if child change flags match. More...

bool	isDetaching () const
	Returns true if the node currently detaching. More...

bool	isEffectivelyFocusable () const
	Returns whether a node is focusable. More...

bool	isEffectivelyVisible () const
	Returns whether a node and its ancestor nodes are visible. More...

bool	isInitialized () const
	Returns true if initialize() has been called, false otherwise. More...

bool	isInvalidArrange () const
	Checks if the node needs arrange. More...

bool	isInvalidDraw ()
	Tells if node draw flag is invalid. More...

bool	isInvalidFinalTransform () const
	Tells if final transform flag is invalid for node. More...

bool	isInvalidMeasure () const
	Check if the node needs measure. More...

bool	isInvalidRender () const
	Returns if node render flag is invalid. More...

bool	isNamed (string_view name) const

	KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty)

template<typename Type >
shared_ptr< Type >	lookupNode (string_view pathOrKey)
	Returns a node of specified type by looking it up with specified path or alias. More...

template<typename Type >
shared_ptr< Type >	lookupNodeComponent (string_view name)
	Returns a node component of specified type by looking it up with specified name. More...

Node *	lookupNodeRaw (string_view relativePath)
	Get an object node by another node and a relative path. More...

ObjectSharedPtr	lookupObject (string_view relativePath)
	Lookup for an object from a node. More...

template<typename Type >
shared_ptr< Type >	lookupObject (string_view relativePath)
	Lookup for an object from a node. More...

tuple< NodeSharedPtr, AbstractPropertyType >	lookupObjectForStateManager (string_view relativePath)
	Lookup for an node and possible object from within the node for state manager. More...

void	notifyResourceDictionaryModified ()
	Forces the re-evaluation of resource IDs in a node tree. More...

void	removeAnonymousResource (const Resource &resource)
	Removes anonymous resource from object node resources. More...

void	removeInputManipulator (InputManipulator &inputManipulator)
	Removes the ownership and detaches an input manipulator from an object node. More...

void	removeKZBData (flat_set< AbstractPropertyType > *keepProperties)
	Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc. More...

void	removeKZBData ()
	Destroys all object node data loaded from KZB. More...

void	removeMessageHandler (MessageSubscriptionToken token)
	Removes a message subscription. More...

void	removeNodeComponent (NodeComponent &nodeComponent)
	Removes the ownership of a node component from an object node. More...

void	removeNodeComponentWithOwner (const void *owner)
	Removes all bindings with the specified owner. More...

void	removeNodeReference (const AbstractNodeReference &reference)

void	removeResource (const ResourceID &resourceId)
	Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. More...

void	removeResourceReference (const AbstractResourceReference &reference)
	This is a helper for automatic resource tracking in ResourceReference. More...

virtual void	restoreResources ()
	Reattaches an object node after potential resource change. More...

void	setChangeFlag (uint32_t flag)
	Sets a change flag. More...

void	setChildChangeFlag (uint32_t flag)
	Sets a child change flag. More...

void	setParent (Node *parent)
	Kanzi uses this method internally to set the parent of a node. More...

void	setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
	Replaces the resource dictionary of a node. More...

void	setScreen (Screen *screen)
	Sets the Screen node to which this node belongs. More...

void	setTemplateRoot (NodeSharedPtr templateRoot)
	Sets the template root of this node. More...

ResourceSharedPtr	tryAcquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...

template<typename T >
shared_ptr< T >	tryAcquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. More...

KZ_DEPRECATED NodeSharedPtr	trySetActiveFocus ()
	Tries to move the focus on this node. More...

NodeSharedPtr	trySetFocus ()
	Tries to move the focus to this node. More...

NodeSharedPtr	trySetFocus (FocusFallback fallbackOption)
	Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus. More...

void	unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
	Unapplies a style from an object node. More...

void	unapplyStyles ()
	Unapplies and removes all applied styles. More...

void	unapplyStylesRecursive ()
	Unapplies styles recursively. More...

void	validateArrange ()
	Validates arrange. More...

void	validateDraw ()
	Validates draw flags for the node. More...

void	validateDrawForChildrenRecursive ()
	Recursively validates draw for the children from this 2D node onwards. More...

void	validateMeasure ()
	Validates measure for the node. More...

void	validateRender ()
	Validates render for node. More...

VisitorResult	visit (const Visitor &visitor, VisitorOrder order)
	Visits a node and its descendants. More...

VisitorResult	visitDescendants (const Visitor &visitor, VisitorOrder order)
	Visits the descendants of a node. More...

	~Node () override
	Destructor. More...

string	getName () const
	Gets the value of NameProperty. More...

void	setName (string_view value)
	Sets the value of NameProperty. More...

string	getPath () const
	Gets the value of PathProperty. More...

void	setPath (string value)
	Sets the value of PathProperty. More...

string	getLocale () const
	Gets the value of LocaleProperty. More...

void	setLocale (string value)
	Sets the value of LocaleProperty. More...

bool	isHitTestable () const
	Gets the value of HitTestableProperty. More...

void	setHitTestable (bool value)
	Sets the value of HitTestableProperty. More...

bool	isHitTestableContainer () const
	Gets the value of HitTestableContainerProperty. More...

void	setHitTestableContainer (bool value)
	Sets the value of HitTestableContainerProperty. More...

bool	isVisible () const
	Gets the value of VisibleProperty. More...

void	setVisible (bool value)
	Sets the value of VisibleProperty. More...

bool	isEnabled () const
	Returns the value of the EnabledProperty. More...

void	setEnabled (bool value)
	Sets the value of the EnabledProperty. More...

bool	isEffectivelyEnabled () const
	Returns the value of EffectivelyEnabledProperty. More...

bool	isFocusable () const
	Gets the value of the FocusableProperty. More...

void	setFocusable (bool value)
	Sets the value of the FocusableProperty. More...

bool	isFocused () const
	Gets the value of the FocusedProperty. More...

void	setFocused (bool value)
	Sets the value of the FocusedProperty. More...

FocusState	getFocusState () const
	Gets the value of the FocusStateProperty. More...

void	setFocusState (FocusState state)
	Sets the value of the FocusStateProperty. More...

FontFamilySharedPtr	getFontFamily () const
	Gets the font family the node uses. More...

void	setFontFamily (FontFamilySharedPtr value)
	Sets the font family the node uses. More...

float	getVisibleAmountInParent () const
	Gets the value of VisibleAmountInParentProperty. More...

void	setVisibleAmountInParent (float value)
	Sets the value of VisibleAmountInParentProperty. More...

float	getProjection2DTo3DScale () const
	Gets the value of Projection2DTo3DScaleProperty. More...

void	setProjection2DTo3DScale (float value)
	Sets the value of Projection2DTo3DScaleProperty. More...

ResourceSharedPtr	getStyle () const
	Gets the value of StyleProperty. More...

void	setStyle (ResourceSharedPtr value)
	Sets the value of StyleProperty. More...

ResourceSharedPtr	getStateManager () const
	Gets the value of StateManagerProperty. More...

void	setStateManager (ResourceSharedPtr value)
	Sets the value of StateManagerProperty. More...

float	getWidth () const
	Gets the value of WidthProperty. More...

void	setWidth (float value)
	Sets the value of WidthProperty. More...

float	getHeight () const
	Gets the value of HeightProperty. More...

void	setHeight (float value)
	Sets the value of HeightProperty. More...

float	getDepth () const
	Gets the value of DepthProperty. More...

void	setDepth (float value)
	Sets the value of DepthProperty. More...

float	getActualWidth () const
	Gets the value of ActualWidthProperty. More...

void	setActualWidth (float value)
	Sets the value of ActualWidthProperty. More...

float	getActualHeight () const
	Gets the value of ActualHeightProperty. More...

void	setActualHeight (float value)
	Sets the value of ActualHeightProperty. More...

float	getActualDepth () const
	Gets the value of ActualDepthProperty. More...

void	setActualDepth (float value)
	Sets the value of ActualDepthProperty. More...

Node::HorizontalAlignment	getHorizontalAlignment () const
	Gets the value of HorizontalAlignmentProperty. More...

void	setHorizontalAlignment (Node::HorizontalAlignment value)
	Sets the value of HorizontalAlignmentProperty. More...

Node::VerticalAlignment	getVerticalAlignment () const
	Gets the value of VerticalAlignmentProperty. More...

void	setVerticalAlignment (Node::VerticalAlignment value)
	Sets the value of VerticalAlignmentProperty. More...

Node::DepthAlignment	getDepthAlignment () const
	Gets the value of DepthAlignmentProperty. More...

void	setDepthAlignment (Node::DepthAlignment value)
	Sets the value of DepthAlignmentProperty. More...

Vector2	getHorizontalMargin () const
	Gets the value of HorizontalMarginProperty. More...

void	setHorizontalMargin (Vector2 value)
	Sets the value of HorizontalMarginProperty. More...

Vector2	getVerticalMargin () const
	Gets the value of VerticalMarginProperty. More...

void	setVerticalMargin (Vector2 value)
	Sets the value of VerticalMarginProperty. More...

Vector2	getDepthMargin () const
	Gets the value of DepthMarginProperty. More...

void	setDepthMargin (Vector2 value)
	Sets the value of DepthMarginProperty. More...

Node::ContentStretch	getContentStretch () const
	Gets the value of ContentStretchProperty. More...

void	setContentStretch (Node::ContentStretch value)
	Sets the value of ContentStretchProperty. More...

float	getOpacity () const
	Gets the value of OpacityProperty. More...

void	setOpacity (float value)
	Sets the value of OpacityProperty. More...

bool	isHover () const
	Returns whether the node has HoverProperty set to true. More...

bool	isClipChildren () const
	Gets the value of ClipChildrenProperty. More...

void	setClipChildren (bool value)
	Sets the value of ClipChildrenProperty. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	applyObjectStyles ()
	Apply all styles for an object node. More...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers. More...

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...

virtual	~PropertyObject ()

Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
void	addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
	Adds an already-created binding runtime to this binding host. More...

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding. More...

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding. More...

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a binding. More...

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot)
	Sets a binding with no target. More...

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding)
	Wrapper for setting a binding with no target. More...

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Sets a binding to a certain property. More...

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding with owner. More...

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a binding with owner. More...

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot)
	Sets a binding with no target. More...

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
	Wrapper for setting a binding with no target. More...

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding. More...

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding. More...

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding. More...

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Sets a modifier binding. More...

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding. More...

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding. More...

Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator	beginBindingRuntimes () const
	Returns an iterator to the beginning of binding runtimes. More...

BindingRuntimeConstIterator	endBindingRuntimes () const
	Returns an iterator to the end of binding runtimes. More...

AbstractBindingRuntimeSharedPtr	getBindingRuntime (size_t idx)
	Gets binding by index. More...

size_t	getBindingRuntimeCount () const
	Gets the number of binding runtimes added to this node. More...

void	removeAllBindings ()
	Removes all binding runtimes. More...

void	removeBinding (BindingRuntimeHandle &bindingRuntime)
	Removes a binding runtime added earlier. More...

void	removeBindingsWithOwner (shared_ptr< void > owner)
	Removes all binding runtimes with the specified owner. More...

Static Public Member Functions
static bool	isUnboundedLayoutSize (Vector3 layoutSize)
	Returns whether a layout size is an unbounded layout size. More...

static bool	isValidLayoutSize (Vector3 size)
	Returns whether a given size is a valid layout size. More...

static float	layoutUp ()
	Returns the direction toward which the y axis of a 3D node grows. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static Vector3	replaceUnboundedLayoutSize (Vector3 layoutSize, Vector3 resetSize)
	Replaces any elements in an unbounded layout size with the corresponding elements of a given size. More...

static Vector3	replaceUnboundedLayoutSizeWithZero (Vector3 layoutSize)
	Replaces any elements in an unbounded layout size with zero. More...

static Vector3	unboundedLayoutSize ()
	Returns an unbounded layout size. More...

Static Public Member Functions inherited from kanzi::Node
static bool	isUnboundedLayoutValue (float layoutValue)
	Indicates whether a value is an unbound layout value. More...

static bool	isValidLayoutValue (float value)
	Indicates whether a value is valid layout value. More...

static float	replaceUnboundedLayoutValue (float layoutValue, float resetValue)
	Replaces layout value with the specified value if it is unbounded and returns it. More...

static float	replaceUnboundedLayoutValueWithZero (float layoutValue)
	Replaces layout value with zero if it is unbounded layout value and returns it. More...

static float	unboundedLayoutValue ()
	Returns an unbounded layout value. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
virtual void	arrangeOverride (Vector3 actualSize)

NodeSharedPtr	findAbstractChildOverride (string_view name) override

virtual const RenderEntryParameterContainer *	generateRenderStatesOverride (DrawObjectsRenderPass &drawPass)
	Node-specific render state generation. More...

void	initialize ()

virtual Vector3	measureOverride (Vector3 availableSize)

	Node3D (Domain *domain, string_view name)

void	onAttached () override
	Node::onAttached() implementation. More...

void	onDetached () override
	Node::onDetached() implementation. More...

virtual void	registerDrawPassOverride (DrawObjectsRenderPassSharedPtr drawPass)
	Node-specific implementation of draw pass registration. More...

virtual void	renderOverride (Renderer3D &renderer, RenderEntry3D &renderEntry)
	Node-specific rendering implementation. More...

void	setPrimitiveLayout (bool primitive)
	Sets primitive layout flag. More...

VisitorResult	visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) override

Protected Member Functions inherited from kanzi::Node
void	attach ()
	Attaches the object node. More...

void	detach ()
	Detaches the object node. More...

void	initialize ()
	Node-specific initialization. More...

	Node (Domain *domain, string_view name)
	Constructor. More...

void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) override
	Notifies all property handlers on a property storage. More...

virtual void	updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo)
	Updates the overlay scope information that is attached to the root node of an overlay scope. More...

void	updatePropertiesForConnectedNode ()
	Invokes property notifications for inherited properties during node tree connections. More...

void	updatePropertiesForDisconnectedNode (Node *oldParent)
	Invokes property notifications for inherited properties during node tree disconnections. More...

void	updateResourceReferences ()

void	updateResourceReferences (AbstractPropertyType propertyType)

void	updateResourceReferencesRecursive ()

void	updateResourceReferencesRecursive (const ResourceID &resourceID)

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers. More...

Protected Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
Node *	getThisObject ()
	Internal accessor for the Curiously Recurring Template Pattern. More...

const Node *	getThisObject () const
	Internal accessor for the Curiously Recurring Template Pattern. More...

Protected Member Functions inherited from kanzi::BindingHostConcept
void	attachBindings ()
	Attach all bindings stored in this object. More...

void	detachBindings ()
	Detach bindings. More...

Properties
static PropertyType< Matrix4x4 >	FinalTransformationProperty
	Sets the final transformation of a 3D node. More...

static PropertyType< float >	FrustumCullMarginProperty
	Sets the margin of the frustum cull radius of a 3D node. More...

static PropertyType< SRTValue3D >	RenderTransformationProperty
	Sets the render transformation of a 3D node. More...

static PropertyType< SRTValue3D >	LayoutTransformationProperty
	Sets the transformation of a 3D node relative to its parent node. More...

Matrix4x4	getFinalTransformation () const
	Gets the value of the FinalTransformationProperty. More...

void	setFinalTransformation (Matrix4x4 value)
	Sets the value of the FinalTransformationProperty. More...

float	getFrustumCullMargin () const
	Gets the value of the FrustumCullMarginProperty. More...

void	setFrustumCullMargin (float value)
	Sets the value of the FrustumCullMarginProperty. More...

SRTValue3D	getRenderTransformation () const
	Gets the value of the RenderTransformationProperty. More...

void	setRenderTransformation (SRTValue3D value)
	Sets the value of the RenderTransformationProperty. More...

SRTValue3D	getLayoutTransformation () const
	Gets the value of the LayoutTransformationProperty. More...

void	setLayoutTransformation (SRTValue3D value)
	Sets the value of the LayoutTransformationProperty. More...

Additional Inherited Members
Static Public Attributes inherited from kanzi::Node
static PropertyType< string >	NameProperty
	Name property. More...

static PropertyType< string >	PathProperty
	Path property. More...

static PropertyType< string >	LocaleProperty
	Locale property. More...

static PropertyType< bool >	CreatedFromKZBProperty
	CreatedFromKZB property. More...

static PropertyType< bool >	HitTestableProperty
	HitTestable property. More...

static PropertyType< bool >	HitTestableContainerProperty
	HitTestableContainer property. More...

static PropertyType< bool >	VisibleProperty
	Visible property. More...

static PropertyType< bool >	EnabledProperty
	Sets whether the node is enabled. More...

static PropertyType< bool >	EffectivelyEnabledProperty
	Indicates whether the node and its ancestor nodes are enabled. More...

static PropertyType< bool >	FocusableProperty
	Sets whether a node can get focus and can participate in the focus chain navigation. More...

static PropertyType< bool >	FocusedProperty
	Sets whether a node is an focus node and can receive key messages. More...

static PropertyType< FocusState >	FocusStateProperty
	Reports the focus state of a focusable node or focus scope node. More...

static PropertyType< ResourceSharedPtr >	FontFamilyProperty
	Sets the font family the node uses. More...

static PropertyType< float >	VisibleAmountInParentProperty
	VisibleAmountInParent property. More...

static PropertyType< float >	Projection2DTo3DScaleProperty
	Projection2DTo3DScale property. More...

static PropertyType< ResourceSharedPtr >	StyleProperty
	Style property. More...

static PropertyType< ResourceSharedPtr >	StateManagerProperty
	StateManager property. More...

static PropertyType< void * >	PrefabTemplateSourceProperty
	PrefabTemplateSource property. More...

static PropertyType< float >	WidthProperty
	Width property. More...

static PropertyType< float >	HeightProperty
	Height property. More...

static PropertyType< float >	DepthProperty
	Depth property. More...

static PropertyType< float >	ActualWidthProperty
	ActualWidth property. More...

static PropertyType< float >	ActualHeightProperty
	ActualHeight property. More...

static PropertyType< float >	ActualDepthProperty
	ActualDepth property. More...

static PropertyType< Node::HorizontalAlignment >	HorizontalAlignmentProperty
	HorizontalAlignment property. More...

static PropertyType< Node::VerticalAlignment >	VerticalAlignmentProperty
	VerticalAlignment property. More...

static PropertyType< Node::DepthAlignment >	DepthAlignmentProperty
	DepthAlignment property. More...

static PropertyType< Vector2 >	HorizontalMarginProperty
	Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...

static PropertyType< Vector2 >	VerticalMarginProperty
	Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...

static PropertyType< Vector2 >	DepthMarginProperty
	Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout. More...

static PropertyType< Node::ContentStretch >	ContentStretchProperty
	ContentStretch property. More...

static PropertyType< float >	OpacityProperty
	Opacity property. More...

static PropertyType< bool >	HoverProperty
	Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor. More...

static PropertyType< bool >	ClipChildrenProperty
	ClipChildren property. More...

static PropertyType< int >	SceneGraphAddNodeChangeChildFlagsProperty
	SceneGraphAddNodeChangeChildFlags property. More...

static PropertyType< int >	SceneGraphAddNodeChangeParentFlagsProperty
	SceneGraphAddNodeChangeParentFlags property. More...

static PropertyType< int >	SceneGraphRemoveNodeChangeChildFlagsProperty
	SceneGraphRemoveNodeChangeChildFlags property. More...

static PropertyType< int >	SceneGraphRemoveNodeChangeParentFlagsProperty
	SceneGraphRemoveNodeChangeParentFlags property. More...

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Static Protected Member Functions inherited from kanzi::Node
static VisitorResult	applyStylesVisitor (Node &node, bool apply)

static VisitorResult	attachVisitor (Node &node)

static VisitorResult	detachVisitor (Node &node)

static bool	processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
	Processes notification handlers for node and property storage. More...

static VisitorResult	propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)

static VisitorResult	updateAllResourcesVisitor (Node &node)

static VisitorResult	updateResourceVisitor (Node &node, const ResourceID &id)

static VisitorResult	validateDrawVisitor (Node &node)
	Visitor for validating draw. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer	m_bindingRuntimes
	Bindings in this object. More...

Detailed Description

Base class for all 3D nodes.

Member Typedef Documentation

using kanzi::Node3D::RenderEntryParameterContainer = vector<RenderEntryParameters>

The type to use to return render entries from nodes.

typedef Vector3 kanzi::Node3D::LayoutVectorType

typedef Matrix4x4 kanzi::Node3D::LayoutMatrixType

typedef vector<Node3DSharedPtr> kanzi::Node3D::ChildContainer

Iterators for child nodes.

typedef ChildContainer::const_iterator kanzi::Node3D::ChildConstIterator

typedef ChildContainer::const_reverse_iterator kanzi::Node3D::ChildConstReverseIterator

Member Enumeration Documentation

enum kanzi::Node3D::RenderMode

Specifies the rendering modes available for a 3D node.

Enumerator

RenderModeNone

The node is not renderable.

RenderModeDefault

The node provides the vertex and index buffers and materials, and does not have custom rendering.

This is the default rendering mode.

RenderModeCustom

Custom rendering mode.

When you use this mode, you must call a custom render function.

Constructor & Destructor Documentation

kanzi::Node3D::~Node3D ( )

override

kanzi::Node3D::Node3D	(	Domain *	domain,
		string_view	name
	)

explicitprotected

Member Function Documentation

static float kanzi::Node3D::layoutUp ( )

inlinestatic

Returns the direction toward which the y axis of a 3D node grows.

Returns: The direction of the y axis.

static bool kanzi::Node3D::isValidLayoutSize ( Vector3 size )

inlinestatic

Returns whether a given size is a valid layout size.

A size is valid if all its elements are valid layout values. See Node::isValidLayoutValue().

Parameters

size	The size to check.

Returns: If the size is a valid layout size, true, otherwise false.

static Vector3 kanzi::Node3D::unboundedLayoutSize ( )

inlinestatic

Returns an unbounded layout size.

Returns: Unbounded layout size.

static bool kanzi::Node3D::isUnboundedLayoutSize ( Vector3 layoutSize )

inlinestatic

Returns whether a layout size is an unbounded layout size.

A layout size is unbounded if any of its elements are unbounded layout values.

Parameters

layoutSize The layout size to check.

Returns: If the layout size is unbounded, true, otherwise false.

static Vector3 kanzi::Node3D::replaceUnboundedLayoutSize	(	Vector3	layoutSize,
		Vector3	resetSize
	)

inlinestatic

Replaces any elements in an unbounded layout size with the corresponding elements of a given size.

Parameters

layoutSize	The layout size to check.
resetSize	The size with whose elements to replace the unbounded value elements of the layout size.

Returns: The layoutSize with its unbounded value elements replaced with the elements of resetSize.

static Vector3 kanzi::Node3D::replaceUnboundedLayoutSizeWithZero ( Vector3 layoutSize )

inlinestatic

Replaces any elements in an unbounded layout size with zero.

Parameters

layoutSize The layout size to check.

Returns: The layoutSize with its unbounded value elements replaced with zeroes.

Matrix4x4 kanzi::Node3D::getFinalTransformation ( ) const

inline

Gets the value of the FinalTransformationProperty.

See also: setFinalTransformation()

void kanzi::Node3D::setFinalTransformation ( Matrix4x4 value )

inline

Sets the value of the FinalTransformationProperty.

See also: getFinalTransformation()

float kanzi::Node3D::getFrustumCullMargin ( ) const

inline

Gets the value of the FrustumCullMarginProperty.

See also: setFrustumCullMargin()

void kanzi::Node3D::setFrustumCullMargin ( float value )

inline

Sets the value of the FrustumCullMarginProperty.

See also: getFrustumCullMargin()

SRTValue3D kanzi::Node3D::getRenderTransformation ( ) const

inline

Gets the value of the RenderTransformationProperty.

See also: setRenderTransformation()

void kanzi::Node3D::setRenderTransformation ( SRTValue3D value )

inline

Sets the value of the RenderTransformationProperty.

See also: getRenderTransformation()

SRTValue3D kanzi::Node3D::getLayoutTransformation ( ) const

inline

Gets the value of the LayoutTransformationProperty.

See also: setLayoutTransformation()

void kanzi::Node3D::setLayoutTransformation ( SRTValue3D value )

inline

Sets the value of the LayoutTransformationProperty.

See also: getLayoutTransformation()

static PropertyTypeEditorInfoSharedPtr kanzi::Node3D::makeEditorInfo ( )

static

size_t kanzi::Node3D::getChildCount ( ) const

Gets the number of child nodes in a 3D node.

Returns: The number of child nodes.

Node3DSharedPtr kanzi::Node3D::getChild ( size_t index ) const

Gets a child node at a given index.

Parameters

index The index of the child node.

Returns: The child node.

size_t kanzi::Node3D::getChildIndex ( const Node & child ) const

Gets the index of a child node.

Parameters

child The child node whose index you want to get.

Returns: The index of the child node.

bool kanzi::Node3D::hasChild ( const Node & child ) const

Returns whether a child node exists.

Parameters

child The child node.

Returns: If the given node is a child of this node, true, otherwise false.

void kanzi::Node3D::addChild ( const Node3DSharedPtr & child )

Adds a child node to a 3D node.

Parameters

child The 3D node that you want to add as a child node.

void kanzi::Node3D::insertChild	(	size_t	index,
		const Node3DSharedPtr &	child
	)

Adds to a 3D node a child node at a given index.

The only 3D node you can add as a child of a 2D node is a Scene node as a child of a Viewport2D node. A Screen node can have only one 2D node as its child node.

Parameters

index	The index at which you want to add the child node.
child	The node that you want to add as a child node.

void kanzi::Node3D::removeChild ( const Node & child )

Removes a child node from a 3D node.

Parameters

child The child node that you want to remove.

void kanzi::Node3D::removeChild ( size_t index )

Removes from a 3D node a child node at a given index.

Parameters

index The index of the child node that you want to remove.

void kanzi::Node3D::removeAllChildren ( )

Removes all child nodes from a 3D node.

ChildConstIterator kanzi::Node3D::beginChildren ( ) const

ChildConstIterator kanzi::Node3D::endChildren ( ) const

ChildConstReverseIterator kanzi::Node3D::rbeginChildren ( ) const

ChildConstReverseIterator kanzi::Node3D::rendChildren ( ) const

bool kanzi::Node3D::addAbstractChildOverride ( NodeSharedPtr child )

overridevirtual

Implements kanzi::Node.

size_t kanzi::Node3D::getAbstractChildCountOverride ( )

overridevirtual

Implements kanzi::Node.

size_t kanzi::Node3D::getAbstractChildIndexOverride ( const Node & node )

overridevirtual

Implements kanzi::Node.

NodeSharedPtr kanzi::Node3D::getAbstractChildOverride ( size_t index )

overridevirtual

Implements kanzi::Node.

bool kanzi::Node3D::removeAbstractChildOverride ( Node & child )

overridevirtual

Implements kanzi::Node.

bool kanzi::Node3D::moveAbstractChildToPositionOverride	(	NodeSharedPtr	child,
		size_t	index
	)

overridevirtual

Node::moveAbstractChildToPosition() implementation.

Implements kanzi::Node.

void kanzi::Node3D::moveToBack ( )

Repositions a 3D node to the beginning of the list of child nodes of its parent node, so that Kanzi draws the node first.

void kanzi::Node3D::moveToFront ( )

Repositions a 3D node to the end of the list of child nodes of its parent node, so that Kanzi draws the node last.

void kanzi::Node3D::moveChildToPosition	(	Node3DSharedPtr	child,
		size_t	index
	)

Moves a child node to a given position in the list of child nodes.

Parameters

child	The child node to reposition.
index	The position at which to place the child node in the list of child nodes.

Since: Kanzi 3.9.3

void kanzi::Node3D::setAutoWidth ( )

Sets a node to determine its width automatically.

void kanzi::Node3D::setAutoHeight ( )

Sets a node to determine its height automatically.

void kanzi::Node3D::setAutoDepth ( )

Sets a node to determine its depth automatically.

void kanzi::Node3D::setAutoSize ( )

Sets a node to determine its width, height, and depth automatically.

void kanzi::Node3D::setSize	(	float	width,
		float	height,
		float	depth
	)

Sets the dimensions of a node.

Parameters

width	The value of the Node::WidthProperty to set.
height	The value of the Node::HeightProperty to set.
depth	The value of the Node::DepthProperty to set.

void kanzi::Node3D::setSize ( Vector3 size )

inline

Sets the dimensions of a node.

Parameters

size	A vector that contains the width, height, and depth to set.

void kanzi::Node3D::setCoreDesiredSize ( const Vector3 & coreDesiredSize )

Sets the core desired size of a 3D node.

Vector3 kanzi::Node3D::getCoreDesiredSize ( ) const

Returns the core desired size of a 3D node.

void kanzi::Node3D::setDesiredSize ( const Vector3 & desiredSize )

Sets the desired size of a 3D node.

Vector3 kanzi::Node3D::getDesiredSize ( ) const

Returns the desired size of a 3D node.

void kanzi::Node3D::setAllocatedSize ( const Vector3 & layoutSize )

Sets the allocated size of a 3D node.

Vector3 kanzi::Node3D::getAllocatedSize ( ) const

Returns the allocated size of a 3D node.

void kanzi::Node3D::setActualSize ( const Vector3 & actualSize )

Sets the actual size of a 3D node.

Vector3 kanzi::Node3D::getActualSize ( ) const

Returns the actual size of a 3D node.

void kanzi::Node3D::setLayoutBoundingBoxSize	(	const Vector3 &	bboxMin,
		const Vector3 &	bboxMax
	)

Sets the size of the bounding box of a 3D node.

void kanzi::Node3D::getLayoutBoundingBoxSize	(	Vector3 &	bboxMin,
		Vector3 &	bboxMax
	)		const

Returns the size of the bounding box of a 3D node.

void kanzi::Node3D::setAllocatedOffset ( const Vector3 & allocatedOffset )

Sets the allocated offset of a 3D node.

Vector3 kanzi::Node3D::getAllocatedOffset ( ) const

Returns the allocated offset of a 3D node.

void kanzi::Node3D::setStretchScale ( const Vector3 & stretchScale )

Sets the stretch scale of a 3D node.

Vector3 kanzi::Node3D::getStretchScale ( ) const

Returns the stretch scale of a 3D node.

void kanzi::Node3D::setPivotOffset ( const Vector3 & pivotOffset )

Sets the pivot offset of a 3D node.

Vector3 kanzi::Node3D::getPivotOffset ( ) const

Returns the pivot offset of a 3D node.

Vector3 kanzi::Node3D::getSize ( ) const

Returns the size of a 3D node.

Vector3 kanzi::Node3D::getMaximumBoundingBoxCoordinates ( ) const

Returns the maximum coordinates for the bounding volume of a 3D node.

Vector3 kanzi::Node3D::getMinimumBoundingBoxCoordinates ( ) const

Returns the minimum coordinates for the bounding volume of a 3D node.

void kanzi::Node3D::setArrangeTransformation ( const Matrix4x4 & value )

Sets the layout transformation of a 3D node.

Parameters

value The layout transformation matrix.

Matrix4x4 kanzi::Node3D::getArrangeTransformation ( ) const

Returns the layout transformation of a 3D node.

void kanzi::Node3D::layout ( )

Calculates the layouts in a scene recursively. Calls the measure and arrange functions of every 3D node in the scene.

void kanzi::Node3D::measureIterate ( )

Initial scene measure.

virtual bool kanzi::Node3D::measureRecursive ( )

virtual

Performs layout measurement for a 3D node.

Reimplemented in kanzi::Viewport3D.

void kanzi::Node3D::arrangeIterate ( )

Initial scene arrange.

void kanzi::Node3D::arrangeIterateLayout ( bool propagateArrange )

void kanzi::Node3D::arrangeIterateLayoutChild ( bool propagateArrange )

void kanzi::Node3D::measure ( const Vector3 & availableSize )

Performs the default measure step.

void kanzi::Node3D::arrange ( )

Performs layout arrangement on a 3D node.

Vector3 kanzi::Node3D::centeredMeasure ( Vector3 availableSize ) const

Default implementation of measure for a layout that accommodates all children at its center.

void kanzi::Node3D::centeredArrange ( Vector3 actualSize ) const

Default implementation of arrange for a layout that accommodates all children at its center.

bool kanzi::Node3D::isPrimitiveLayout ( ) const

inline

Indicates whether a 3D node has primitive layout behavior.

Returns: If the 3D node has primitive layout behavior, true, otherwise false.

void kanzi::Node3D::setRenderMode ( RenderMode mode )

inline

Sets the render mode.

RenderMode kanzi::Node3D::getRenderMode ( ) const

inline

Returns the render mode.

virtual void kanzi::Node3D::onTransform ( )

virtual

Per-node step performed on transform, after Kanzi calculates the final transformation.

The default implementation is empty.

Since: 3.9.4

Reimplemented in kanzi::Viewport3D, and kanzi::Model3D.

const RenderEntryParameterContainer* kanzi::Node3D::generateRenderStates ( DrawObjectsRenderPass & drawPass )

Gets a listing of render entry parameters to use to generate render states.

The returned pointer can be null and is considered owned by the node. Do not modify it.

Parameters

drawPass DrawObjectsRenderPass that invokes the generation.

Returns: Vector of parameters for generating render entries.

void kanzi::Node3D::registerDrawPass ( DrawObjectsRenderPassSharedPtr drawPass )

Registers a DrawObjectsRenderPass that renders a 3D node.

Parameters

drawPass The Draw Objects Render Pass that generated a render state for this node.

void kanzi::Node3D::render	(	Renderer3D &	renderer,
		RenderEntry3D &	renderEntry
	)

Renders a 3D node using a given render state.

The render state host contains the relevant information related to rendering, including the index.

Parameters

renderer	Renderer to use.
renderEntry	Render entry being rendered.

Node3DSharedPtr kanzi::Node3D::getLookAtTarget ( ) const

Node3DSharedPtr kanzi::Node3D::getPositionConstraintTarget ( ) const

Node3DSharedPtr kanzi::Node3D::getOrientationConstraintTarget ( ) const

Node3DSharedPtr kanzi::Node3D::getFaceToCameraTarget ( ) const

void kanzi::Node3D::onNodePropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason
	)

overridevirtual

Method executed on node property change.

Parameters

propertyType	Property that was changed in node.
reason	Change reason.

Reimplemented from kanzi::Node.

virtual optional<Box> kanzi::Node3D::getBoundingBox ( ) const

virtual

Gets the bounding box of a 3D node.

Renderable nodes, such as Model3D and TextBlock3D, typically have a bounding box. Non-renderable nodes do not have a bounding box.

Returns: Axis-aligned bounding box of the node. If the node does not have a bounding box, nullopt.

Reimplemented in kanzi::Instantiator3D, kanzi::TextBox3D, kanzi::TextBlock3D, and kanzi::Model3D.

virtual pair<NodeSharedPtr, float> kanzi::Node3D::hitTestContent ( const Ray & ray )

virtual

Default hit test implementation of Node3D content.

Hit tests the node using either:

The ray that intersects the bounding box of the node.
If Node::HitTestableContainerProperty is true, the layout bounds of the node.

Parameters

ray	World space ray to use for hit testing the content.

Returns: A pair object that contains the found node and the distance along the ray.

Since: Kanzi 3.9.6

Reimplemented in kanzi::Viewport3D.

void kanzi::Node3D::onAttached ( )

overrideprotectedvirtual

Node::onAttached() implementation.

Reimplemented from kanzi::Node.

Reimplemented in kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >, kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >, kanzi::TrajectoryListBox3D, kanzi::ButtonConceptImpl< Node3D, Button3D >, kanzi::ButtonConceptImpl< Node3D, ToggleButton3D >, kanzi::TextBox3D, kanzi::Viewport3D, kanzi::ActivityConceptImpl< ContentLayout3D, Activity3D >, kanzi::ClickConceptImpl< Node3D, Button3D >, kanzi::ClickConceptImpl< ContentLayout3D, ListBoxItemContainer3D >, kanzi::ClickConceptImpl< Node3D, ToggleButton3D >, kanzi::ParallelActivityHostImpl< ContentLayout3D, ParallelActivityHost3D >, kanzi::ActivityElementImpl< ContentLayout3D, ParallelActivityHost3D >, kanzi::ActivityElementImpl< ContentLayout3D, DataDrivenExclusiveActivityHost3D >, kanzi::ActivityElementImpl< ContentLayout3D, ExclusiveActivityHost3D >, and kanzi::ActivityElementImpl< ContentLayout3D, Activity3D >.

void kanzi::Node3D::onDetached ( )

overrideprotectedvirtual

Node::onDetached() implementation.

Reimplemented from kanzi::Node.

void kanzi::Node3D::initialize ( )

protected

NodeSharedPtr kanzi::Node3D::findAbstractChildOverride ( string_view name )

overrideprotectedvirtual

Implements kanzi::Node.

Reimplemented in kanzi::Viewport3D.

VisitorResult kanzi::Node3D::visitAbstractChildOverride	(	const Visitor &	visitor,
		VisitorOrder	order
	)

overrideprotectedvirtual

Implements kanzi::Node.

Reimplemented in kanzi::Viewport3D.

virtual Vector3 kanzi::Node3D::measureOverride ( Vector3 availableSize )

protectedvirtual

Reimplemented in kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >, kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >, kanzi::TextBox3D, kanzi::TextBlock3D, kanzi::Viewport3D, kanzi::ToggleButtonGroupConceptImpl< Node3D, ToggleButtonGroup3D >, kanzi::GridLayout3D, kanzi::TrajectoryLayout3D, kanzi::FlowLayout3D, kanzi::StackLayout3D, kanzi::ContentLayout3D, kanzi::DockLayout3D, and kanzi::PrefabView3D.

virtual void kanzi::Node3D::arrangeOverride ( Vector3 actualSize )

protectedvirtual

Reimplemented in kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits >, kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >, kanzi::GridListBox3D, kanzi::TextBox3D, kanzi::TextBlock3D, kanzi::GridLayout3D, kanzi::TrajectoryLayout3D, kanzi::FlowLayout3D, kanzi::StackLayout3D, kanzi::ContentLayout3D, and kanzi::DockLayout3D.

virtual const RenderEntryParameterContainer* kanzi::Node3D::generateRenderStatesOverride ( DrawObjectsRenderPass & drawPass )

protectedvirtual

Node-specific render state generation.

Default implementation is empty.

Parameters

drawPass DrawObjectsRenderPass invoking the generation.

Returns: nullptr by default.

Reimplemented in kanzi::TextBox3D, kanzi::Instantiator3D, kanzi::Model3D, kanzi::TextBlock3D, and kanzi::Viewport3D.

virtual void kanzi::Node3D::registerDrawPassOverride ( DrawObjectsRenderPassSharedPtr drawPass )

protectedvirtual

Node-specific implementation of draw pass registration.

Implementations of this method should usually call RenderEntryRegistry::insertReferringDrawPass().

Parameters

drawPass Draw pass that generated a render state for this node.

Reimplemented in kanzi::TextBox3D, kanzi::Instantiator3D, kanzi::Model3D, kanzi::TextBlock3D, and kanzi::Viewport3D.

virtual void kanzi::Node3D::renderOverride	(	Renderer3D &	renderer,
		RenderEntry3D &	renderEntry
	)

protectedvirtual

Node-specific rendering implementation.

Default implementation throws an error, because the default implementation should not generate a render state.

Parameters

renderer	Renderer to use.
renderEntry	Render entry being rendered.

Reimplemented in kanzi::Instantiator3D, kanzi::TextBox3D, kanzi::Model3D, kanzi::TextBlock3D, and kanzi::Viewport3D.

void kanzi::Node3D::setPrimitiveLayout ( bool primitive )

inlineprotected

Sets primitive layout flag.

Parameters

primitive Primitive layout flag state.

Member Data Documentation

PropertyType<Matrix4x4> kanzi::Node3D::FinalTransformationProperty

static

Sets the final transformation of a 3D node.

The default value is Matrix4x4(1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 1.0f).

See also: setFinalTransformation(), getFinalTransformation()

PropertyType<float> kanzi::Node3D::FrustumCullMarginProperty

static

Sets the margin of the frustum cull radius of a 3D node.

For example, set the frustum cull margin when you use a shader to modify the geometry of a node.

The default value is 0.0f.

See also: setFrustumCullMargin(), getFrustumCullMargin()

PropertyType<SRTValue3D> kanzi::Node3D::RenderTransformationProperty

static

Sets the render transformation of a 3D node.

Render transformation transforms a node after Kanzi applies the layout pass, but before it renders the node. For example, this allows you to animate nodes in a layout without causing Kanzi to recalculate the layout.

The default value is SRTValue3D(Vector3(1.0f, 1.0f, 1.0f), Vector3(0.0f, 0.0f, 0.0f), Vector3(0.0f, 0.0f, 0.0f)).

See also: setRenderTransformation(), getRenderTransformation()

PropertyType<SRTValue3D> kanzi::Node3D::LayoutTransformationProperty

static

Sets the transformation of a 3D node relative to its parent node.

Layout transformation transforms a node before Kanzi applies the layout pass.

The default value is SRTValue3D(Vector3(1.0f, 1.0f, 1.0f), Vector3(0.0f, 0.0f, 0.0f), Vector3(0.0f, 0.0f, 0.0f)).

See also: setLayoutTransformation(), getLayoutTransformation()

The documentation for this class was generated from the following file:

kanzi/core.ui/node/node3d.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation